<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>lib.scripting.Window</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;lib ::
        <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
        Class&nbsp;Window
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="lib.scripting.Window-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Window</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Window">source&nbsp;code</a></span></p>
<p>Basic window management using wmctrl</p>
  <p>Note: in all cases where a window title is required (with the 
  exception of wait_for_focus()), two special values of window title are 
  permitted:</p>
  <p>:ACTIVE: - select the currently active window :SELECT: - select the 
  desired window by clicking on it</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">mediator</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">boolean</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#wait_for_focus" class="summary-sig-name">wait_for_focus</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">5</span>)</span><br />
      Wait for window with the given title to have focus</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_focus">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">boolean</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#wait_for_exist" class="summary-sig-name">wait_for_exist</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">5</span>)</span><br />
      Wait for window with the given title to be created</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_exist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#activate" class="summary-sig-name">activate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">switchDesktop</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
      Activate the specified window, giving it input focus</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.activate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
      Close the specified window gracefully</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.close">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#resize_move" class="summary-sig-name">resize_move</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">xOrigin</span>=<span class="summary-sig-default">-1</span>,
        <span class="summary-sig-arg">yOrigin</span>=<span class="summary-sig-default">-1</span>,
        <span class="summary-sig-arg">width</span>=<span class="summary-sig-default">-1</span>,
        <span class="summary-sig-arg">height</span>=<span class="summary-sig-default">-1</span>,
        <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
      Resize and/or move the specified window</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.resize_move">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#move_to_desktop" class="summary-sig-name">move_to_desktop</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">deskNum</span>,
        <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
      Move the specified window to the given desktop</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.move_to_desktop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#switch_desktop" class="summary-sig-name">switch_desktop</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">deskNum</span>)</span><br />
      Switch to the specified desktop</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.switch_desktop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#set_property" class="summary-sig-name">set_property</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">action</span>,
        <span class="summary-sig-arg">prop</span>,
        <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
      Set a property on the given window using the specified action</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.set_property">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, int, int, int)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_geometry" class="summary-sig-name">get_active_geometry</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Get the geometry of the currently active window</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_geometry">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_title" class="summary-sig-name">get_active_title</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Get the visible title of the currently active window</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_class" class="summary-sig-name">get_active_class</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Get the class of the currently active window</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_class">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__runWmctrl"></a><span class="summary-sig-name">__runWmctrl</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#Window.__runWmctrl">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="wait_for_focus"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_focus</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">timeOut</span>=<span class="sig-default">5</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_focus">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Wait for window with the given title to have focus</p>
  <p>Usage: <code>window.wait_for_focus(title, timeOut=5)</code></p>
  <p>If the window becomes active, returns True. Otherwise, returns False 
  if the window has not become active by the time the timeout has 
  elapsed.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - title to match against (as a regular expression)</li>
        <li><strong class="pname"><code>timeOut</code></strong> - period (seconds) to wait before giving up</li>
    </ul></dd>
    <dt>Returns: boolean</dt>
  </dl>
</td></tr></table>
</div>
<a name="wait_for_exist"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_exist</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">timeOut</span>=<span class="sig-default">5</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_exist">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Wait for window with the given title to be created</p>
  <p>Usage: <code>window.wait_for_exist(title, timeOut=5)</code></p>
  <p>If the window is in existence, returns True. Otherwise, returns False 
  if the window has not been created by the time the timeout has 
  elapsed.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - title to match against (as a regular expression)</li>
        <li><strong class="pname"><code>timeOut</code></strong> - period (seconds) to wait before giving up</li>
    </ul></dd>
    <dt>Returns: boolean</dt>
  </dl>
</td></tr></table>
</div>
<a name="activate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">activate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">switchDesktop</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.activate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Activate the specified window, giving it input focus</p>
  <p>Usage: <code>window.activate(title, switchDesktop=False, 
  matchClass=False)</code></p>
  <p>If switchDesktop is False (default), the window will be moved to the 
  current desktop and activated. Otherwise, switch to the window's current 
  desktop and activate it there.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring 
          match)</li>
        <li><strong class="pname"><code>switchDesktop</code></strong> - whether or not to switch to the window's current desktop</li>
        <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="close"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.close">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Close the specified window gracefully</p>
  <p>Usage: <code>window.close(title, matchClass=False)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring 
          match)</li>
        <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="resize_move"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">resize_move</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">xOrigin</span>=<span class="sig-default">-1</span>,
        <span class="sig-arg">yOrigin</span>=<span class="sig-default">-1</span>,
        <span class="sig-arg">width</span>=<span class="sig-default">-1</span>,
        <span class="sig-arg">height</span>=<span class="sig-default">-1</span>,
        <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.resize_move">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Resize and/or move the specified window</p>
  <p>Usage: <code>window.close(title, xOrigin=-1, yOrigin=-1, width=-1, 
  height=-1, matchClass=False)</code></p>
  <p>Leaving and of the position/dimension values as the default (-1) will 
  cause that value to be left unmodified.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring 
          match)</li>
        <li><strong class="pname"><code>xOrigin</code></strong> - new x origin of the window (upper left corner)</li>
        <li><strong class="pname"><code>yOrigin</code></strong> - new y origin of the window (upper left corner)</li>
        <li><strong class="pname"><code>width</code></strong> - new width of the window</li>
        <li><strong class="pname"><code>height</code></strong> - new height of the window</li>
        <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="move_to_desktop"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">move_to_desktop</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">deskNum</span>,
        <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.move_to_desktop">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Move the specified window to the given desktop</p>
  <p>Usage: <code>window.move_to_desktop(title, deskNum, 
  matchClass=False)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring 
          match)</li>
        <li><strong class="pname"><code>deskNum</code></strong> - desktop to move the window to (note: zero based)</li>
        <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="switch_desktop"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">switch_desktop</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">deskNum</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.switch_desktop">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Switch to the specified desktop</p>
  <p>Usage: <code>window.switch_desktop(deskNum)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>deskNum</code></strong> - desktop to switch to (note: zero based)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="set_property"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_property</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>,
        <span class="sig-arg">action</span>,
        <span class="sig-arg">prop</span>,
        <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.set_property">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set a property on the given window using the specified action</p>
  <p>Usage: <code>window.set_property(title, action, prop, 
  matchClass=False)</code></p>
  <p>Allowable actions: <code>add, remove, toggle</code> Allowable 
  properties: <code>modal, sticky, maximized_vert, maximized_horz, shaded, 
  skip_taskbar, skip_pager, hidden, fullscreen, above</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring 
          match)</li>
        <li><strong class="pname"><code>action</code></strong> - one of the actions listed above</li>
        <li><strong class="pname"><code>prop</code></strong> - one of the properties listed above</li>
        <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="get_active_geometry"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_geometry</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_geometry">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get the geometry of the currently active window</p>
  <p>Usage: <code>window.get_active_geometry()</code></p>
  <dl class="fields">
    <dt>Returns: <code>tuple(int, int, int, int)</code></dt>
        <dd>a 4-tuple containing the x-origin, y-origin, width and height of 
          the window (in pixels)</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_active_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_title</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get the visible title of the currently active window</p>
  <p>Usage: <code>window.get_active_title()</code></p>
  <dl class="fields">
    <dt>Returns: <code>str</code></dt>
        <dd>the visible title of the currentle active window</dd>
  </dl>
</td></tr></table>
</div>
<a name="get_active_class"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_class</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_class">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Get the class of the currently active window</p>
  <p>Usage: <code>window.get_active_class()</code></p>
  <dl class="fields">
    <dt>Returns: <code>str</code></dt>
        <dd>the class of the currentle active window</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
